<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Pike_Grid_Datasource_Doctrine_Paginate</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Pike_Grid_Datasource_Doctrine_Paginate</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Copyright (C) 2011 by Pieter Vogelaar (Platina Designs) and Kees Schepers (SkyConcepts)</p>
<p class="description"><p>Permission is hereby granted, free of charge, to any person obtaining a copy  of this software and associated documentation files (the &quot;Software&quot;), to deal  in the Software without restriction, including without limitation the rights  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell  copies of the Software, and to permit persons to whom the Software is  furnished to do so, subject to the following conditions:</p><p>The above copyright notice and this permission notice shall be included in  all copies or substantial portions of the Software.</p><p>THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN  THE SOFTWARE.</p></p>
		<p class="notes">
			Located in <a class="field" href="_Grid---Datasource---Doctrine---Paginate.php.html">/Grid/Datasource/Doctrine/Paginate.php</a> (line <span class="field">27</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
												<div class="method-definition">
					static 						<span class="method-result">Query</span>
										<a href="#cloneQuery" title="details" class="method-name">cloneQuery</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$query</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">int</span>
										<a href="#count" title="details" class="method-name">count</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$query</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">Query</span>
										<a href="#createCountQuery" title="details" class="method-name">createCountQuery</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$query</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$hints</span> = <span class="var-default">array()</span>])
									</div>
																<div class="method-definition">
					static 						<span class="method-result">Query</span>
										<a href="#createLimitSubQuery" title="details" class="method-name">createLimitSubQuery</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$query</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$offset</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$itemCountPerPage</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$phints</span> = <span class="var-default">array()</span>])
									</div>
																<div class="method-definition">
					static 						<span class="method-result">Query</span>
										<a href="#createWhereInQuery" title="details" class="method-name">createWhereInQuery</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$query</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$ids</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$namespace</span> = <span class="var-default">'pgid'</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$phints</span> = <span class="var-default">array()</span>])
									</div>
																<div class="method-definition">
					static 						<span class="method-result">Query</span>
										<a href="#getPaginateQuery" title="details" class="method-name">getPaginateQuery</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$query</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$offset</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$itemCountPerPage</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$hints</span> = <span class="var-default">array()</span>])
									</div>
																<div class="method-definition">
					static 						<span class="method-result">int</span>
										<a href="#getTotalQueryResults" title="details" class="method-name">getTotalQueryResults</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$query</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$hints</span> = <span class="var-default">array()</span>])
									</div>
								
																																																												</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodcloneQuery" id="cloneQuery"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method cloneQuery</span> (line <span class="line-number">33</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">Query</span>
		<span class="method-name">
			cloneQuery
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$query</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">Query</span>
				<span class="var-name">$query</span>			</li>
				</ul>
		
			
	</div>
<a name="methodcount" id="count"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method count</span> (line <span class="line-number">53</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">int</span>
		<span class="method-name">
			count
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$query</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">Query</span>
				<span class="var-name">$query</span>			</li>
				</ul>
		
			
	</div>
<a name="methodcreateCountQuery" id="createCountQuery"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method createCountQuery</span> (line <span class="line-number">84</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">Query</span>
		<span class="method-name">
			createCountQuery
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$query</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$hints</span> = <span class="var-default">array()</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">Query</span>
				<span class="var-name">$query</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$hints</span>			</li>
				</ul>
		
			
	</div>
<a name="methodcreateLimitSubQuery" id="createLimitSubQuery"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method createLimitSubQuery</span> (line <span class="line-number">110</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">Query</span>
		<span class="method-name">
			createLimitSubQuery
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$query</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$offset</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$itemCountPerPage</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$phints</span> = <span class="var-default">array()</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">Query</span>
				<span class="var-name">$query</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$offset</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$itemCountPerPage</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$phints</span>			</li>
				</ul>
		
			
	</div>
<a name="methodcreateWhereInQuery" id="createWhereInQuery"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method createWhereInQuery</span> (line <span class="line-number">133</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">Query</span>
		<span class="method-name">
			createWhereInQuery
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$query</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$ids</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$namespace</span> = <span class="var-default">'pgid'</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$phints</span> = <span class="var-default">array()</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">Query</span>
				<span class="var-name">$query</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$ids</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$namespace</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$phints</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetPaginateQuery" id="getPaginateQuery"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method getPaginateQuery</span> (line <span class="line-number">73</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Given the Query it returns a new query that is a paginatable query using a modified subselect.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">Query</span>
		<span class="method-name">
			getPaginateQuery
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$query</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$offset</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$itemCountPerPage</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$hints</span> = <span class="var-default">array()</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">Query</span>
				<span class="var-name">$query</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$offset</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$itemCountPerPage</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$hints</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetTotalQueryResults" id="getTotalQueryResults"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method getTotalQueryResults</span> (line <span class="line-number">62</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">int</span>
		<span class="method-name">
			getTotalQueryResults
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$query</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$hints</span> = <span class="var-default">array()</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">Query</span>
				<span class="var-name">$query</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$hints</span>			</li>
				</ul>
		
			
	</div>

						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Thu, 15 Sep 2011 15:50:22 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>